/**
 *  Copyright 2009-2010 Steven Ottenhoff (Dual-IT)
 * 
 *  This file is part of Clazzified.
 *
 *  Clazzified is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Clazzified is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Clazzified.  If not, see http://www.gnu.org/licenses/gpl.
 * 
 */
package nl.dualit.clazzified.core.model.relation;

import java.util.List;
import java.util.Map;

import nl.dualit.clazzified.core.model.clazz.Clazz;
import nl.dualit.clazzified.store.clazz.RelationFields;

/**
 * Represent a relation between a clazz and one or more other
 * clazzes.
 * 
 * @author Steven Ottenhoff
 *
 */
public interface IRelation {
	public Long getId();
	public void setId( Long id );
	public String getName();
	public void setName( String name );
	public String getDescription();
	public void setDescription( String name );
	
	/**
	 * Get all peers for this relation.
	 * 
	 * @return
	 */
	public List<Clazz> getPeers();
	/**
	 * Add a peer clazz to the relation.
	 * 
	 * @param clazz
	 */
	public void addPeer( Clazz clazz );
	/**
	 * Remove a peer clazz from the relation.
	 * 
	 * @param clazz
	 */
	public void removePeer( Clazz clazz );
	/**
	 * Return a map of the definition of the relation.
	 * 
	 * @return map
	 */
	public Map<RelationFields,String> getDataMap();
	
}
